Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat: add proto annotation for Msg services #13178

Merged
merged 15 commits into from
Sep 14, 2022
Merged

feat: add proto annotation for Msg services #13178

merged 15 commits into from
Sep 14, 2022

Conversation

aaronc
Copy link
Member

@aaronc aaronc commented Sep 7, 2022 •
edited
Loading

Description

Similarly to #13174, this adds the cosmos.msg.v1.service annotation as specified in #12972 and #12239.

This will allow tooling to distinguish between Msg and Query services via reflection which could allow:

  • unified registration of services with a single grpc.ServiceRegistrar
  • use of a single grpc.ClientConnInterface for ADR-033

Author Checklist

All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.

I have...

  • included the correct type prefix in the PR title
  • added ! to the type prefix if API or client breaking change
  • targeted the correct branch (see PR Targeting)
  • provided a link to the relevant issue or specification
  • followed the guidelines for building modules
  • included the necessary unit and integration tests
  • added a changelog entry to CHANGELOG.md
  • included comments for documenting Go code
  • updated the relevant documentation or specification
  • reviewed "Files changed" and left comments if necessary
  • confirmed all CI checks have passed

Reviewers Checklist

All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.

I have...

  • confirmed the correct type prefix in the PR title
  • confirmed ! in the type prefix if API or client breaking change
  • confirmed all author checklist items have been addressed
  • reviewed state machine logic
  • reviewed API design and naming
  • reviewed documentation is accurate
  • reviewed tests and test coverage
  • manually tested (if applicable)

@aaronc aaronc marked this pull request as ready for review September 7, 2022 16:49
@aaronc aaronc requested a review from a team as a code owner September 7, 2022 16:49
tac0turtle
tac0turtle previously requested changes Sep 7, 2022
View reviewed changes
Copy link
Member

@tac0turtle tac0turtle left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This needs a changelog and documentation. I'm not sure how this really plays into framework or if this is the right path.

@aaronc
Copy link
Member Author

aaronc commented Sep 7, 2022

This needs a changelog and documentation. I'm not sure how this really plays into framework or if this is the right path.

I'll add a changelog entry.

What alternative would you suggest? Not sure what other documentation is needed. This simply annotates services as Msg services so any sort of tooling can distinguish between Msg and Query services.

@codecov
Copy link

codecov bot commented Sep 7, 2022 •
edited
Loading

Codecov Report

Merging #13178 (8305330) into main (641ab20) will increase coverage by 0.07%.
The diff coverage is n/a.

Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main   #13178      +/-   ##
==========================================
+ Coverage   54.94%   55.01%   +0.07%     
==========================================
  Files         648      653       +5     
  Lines       55366    55521     +155     
==========================================
+ Hits        30419    30544     +125     
- Misses      22501    22522      +21     
- Partials     2446     2455       +9
Impacted Files Coverage Δ
tx/textual/valuerenderer/dec.go 72.41% <0.00%> (ø)
tx/textual/valuerenderer/valuerenderer.go 78.72% <0.00%> (ø)
tx/textual/valuerenderer/timestamp.go 100.00% <0.00%> (ø)
tx/textual/valuerenderer/bytes.go 53.84% <0.00%> (ø)
tx/textual/valuerenderer/int.go 77.77% <0.00%> (ø)
x/group/keeper/keeper.go 56.64% <0.00%> (+0.39%) ⬆️
crypto/keys/internal/ecdsa/privkey.go 83.01% <0.00%> (+1.88%) ⬆️

amaury1093
amaury1093 approved these changes Sep 8, 2022
View reviewed changes
Copy link
Contributor

@amaury1093 amaury1093 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@amaury1093
Copy link
Contributor

amaury1093 commented Sep 8, 2022 •
edited
Loading

Not sure what other documentation is needed.

Module developer docs, and maybe upgrading guide. Or else the app developers' Msg services won't get hooked with e.g. the auto-generated cli when they upgrade their sdk version.

kocubinski
kocubinski approved these changes Sep 8, 2022
View reviewed changes
Copy link
Member

@kocubinski kocubinski left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Additive metadata so LGTM.

@aaronc
Copy link
Member Author

aaronc commented Sep 9, 2022

Okay to move forward with this @marbar3778 ?

@tac0turtle tac0turtle enabled auto-merge (squash) September 12, 2022 08:35
@github-actions github-actions bot added C:Cosmovisor Issues and PR related to Cosmovisor and removed Type: Build C:x/bank labels Sep 12, 2022
@aaronc aaronc disabled auto-merge September 12, 2022 13:44
@aaronc aaronc enabled auto-merge (squash) September 12, 2022 13:51
@aaronc aaronc disabled auto-merge September 12, 2022 13:51
@github-actions github-actions bot removed the C:Cosmovisor Issues and PR related to Cosmovisor label Sep 12, 2022
@aaronc
Copy link
Member Author

aaronc commented Sep 12, 2022

@marbar3778 it seems that github auto-merge won't work without an explicit approval from you. It says:
image

Because you reviewed on behalf of cosmos/sdk-core-dev previously then seems like you automatically become the reviewer for that team even though @AmauryM and @kocubinski approved:
image

Strange...

@tac0turtle tac0turtle enabled auto-merge (squash) September 12, 2022 14:07
@tac0turtle tac0turtle added the A:automerge Automatically merge PR once all prerequisites pass. label Sep 14, 2022
@tac0turtle tac0turtle merged commit 5deb137 into main Sep 14, 2022
@tac0turtle tac0turtle deleted the aaronc/msg-service-proto branch September 14, 2022 09:27
@aaronc aaronc mentioned this pull request Sep 27, 2022
Closed
@DimitrisJim DimitrisJim mentioned this pull request May 22, 2023
Closed
3 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@atheeshp atheeshp atheeshp approved these changes

@tac0turtle tac0turtle tac0turtle approved these changes

@amaury1093 amaury1093 amaury1093 approved these changes

@kocubinski kocubinski kocubinski approved these changes

Assignees
No one assigned
Labels
A:automerge Automatically merge PR once all prerequisites pass. C:x/auth C:x/authz C:x/bank C:x/crisis C:x/distribution distribution module related C:x/evidence C:x/feegrant C:x/gov C:x/group C:x/mint C:x/nft C:x/slashing C:x/staking C:x/upgrade
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@aaronc @amaury1093 @kocubinski @tac0turtle @atheeshp